IMotion.SetAxisHomeSwitch method

Sets a digital sensor to be used as a homing switch.

Namespace: IntervalZero.KINGSTAR.Base.Api

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

KsError SetAxisHomeSwitch(
       int Index,
       bool AxisSwitch,
       int ModuleIndex,
       int BitOffset,
       bool Invert
)

Function SetAxisHomeSwitch(
       Index As Integer,
       AxisSwitch As Boolean,
       ModuleIndex As Integer,
       BitOffset As Integer,
       Invert As Boolean
) As KsError

Parameters

Index

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

AxisSwitch

Type: bool

Set to true if the sensor is connected to an axis input, or set to false if it is connected to an I/O module.

ModuleIndex

Type: int

Identifies which I/O module or axis contains the sensor. Aliases affect this parameter.

BitOffset

Type: int

The offset in bit of the sensor digital input in the module input variables.

Invert

Type: bool

Inverts the sensor value.

Return value

Type: KsError

A return code of a method.

Remarks

Used to set which digital input to use as a sensor before starting homing.

Examples

N/A